package org.jsola.contract.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.contract.dto.AppendixAddDTO;
import org.jsola.contract.dto.AppendixUpdateDTO;
import org.jsola.contract.query.AppendixQuery;
import org.jsola.contract.vo.AppendixListSiteIdVO;
import org.jsola.contract.vo.AppendixListVO;
import org.jsola.contract.vo.AppendixVO;
import org.jsola.core.Page;
import org.jsola.core.Result;

import java.util.List;

/**
 * 合同文件
 *
 * @author JanusMix
 */
@Api(tags = "contract-合同文件")
public interface IAppendixControllerAPI {

    /**
     * 新增合同文件
     *
     * @param appendixAddDTO 合同文件新增实体
     * @return 合同文件展示对象
     */
    @ApiOperation(value = "新增合同文件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "appendixAddDTO", dataType = "AppendixAddDTO", value = "新增合同文件", paramType = "body")
    })
    Result<AppendixVO> save(AppendixAddDTO appendixAddDTO);


    /**
     * 修改合同文件
     *
     * @param appendixUpdateDTO 合同文件
     * @return 更新数量
     */
    @ApiOperation(value = "修改合同文件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "appendixUpdateDTO", dataType = "AppendixUpdateDTO", value = "修改合同文件", paramType = "body")
    })
    Result<Integer> update(AppendixUpdateDTO appendixUpdateDTO);


    /**
     * 删除单个合同文件，彻底删除
     *
     * @param appendixId 合同文件id
     * @return 删除数量
     */
    @ApiOperation(value = "删除单个合同文件，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "appendixId", dataType = "Long", value = "合同文件id", paramType = "path")
    })
    Result<Integer> delete(Long appendixId);


    /**
     * 批量删除合同文件，彻底删除
     *
     * @param appendixIds 合同文件id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除合同文件，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "appendixIds", dataType = "Long[]", value = "合同文件id数组", paramType = "body", allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] appendixIds);


    /**
     * 根据合同文件id查询合同文件详情
     *
     * @param appendixId 合同文件id
     * @return 合同文件详情
     */
    @ApiOperation(value = "根据合同文件id查询合同文件详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "appendixId", dataType = "Long", value = "合同文件id", paramType = "path")
    })
    Result<AppendixVO> findById(Long appendixId);


    /**
     * 查询合同文件
     *
     * @param appendixQuery 合同文件查询参数
     * @return page
     */
    @ApiOperation(value = "查询合同文件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "appendixQuery", dataType = "AppendixQuery", value = "合同文件查询参数", paramType = "query")
    })
    Result<List<AppendixListVO>> listAll(AppendixQuery appendixQuery);

    /**
     * 根据合同id查询合同文件（会返回合同相关信息）
     *
     * @param contractIdStr 合同id
     * @return page
     */
    @ApiOperation(value = "根据合同id查询合同文件（会返回合同相关信息）")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractId", dataType = "String", value = "合同id", paramType = "path")
    })
    Result<AppendixVO> selectByContractId(String contractIdStr);


    /**
     * 分页查询合同文件
     *
     * @param appendixQuery 合同文件查询参数
     * @return page
     */
    @ApiOperation(value = "分页查询合同文件")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "appendixQuery", dataType = "AppendixQuery", value = "合同文件查询参数", paramType = "query")
    })
    Result<Page<AppendixListVO>> page(AppendixQuery appendixQuery);


    /**
     * 更换合同PDf的名称,站点下全部更换
     *
     * @return success
     */
    @ApiOperation(value = "更换合同PDf的名称为合同名称(签署编号),站点下全部更换")
    Result<String> renameContractPdf();

    /**
     * 查询合同文件(不需要siteId)
     *
     * @param appendixQuery 合同文件查询参数
     * @return page
     */
    @ApiOperation(value = "查询合同文件(不需要siteId)")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "appendixQuery", dataType = "AppendixQuery", value = "合同文件查询参数", paramType = "query")
    })
    Result<List<AppendixListSiteIdVO>> listAllNoSiteId(AppendixQuery appendixQuery);


}

